d払い(随時決済) 利用承諾 API一覧
HTTP仕様(.idPass)
HTTP仕様(.json)
Request header |
Content-Type: application/x-www-form-urlencoded;charset=windows-31j |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: text/plain;charset=windows-31j |
|
Status Code |
200:常に200を返却 |
Request header |
Content-Type: application/json;charset=UTF-8 |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: application/json;charset=UTF-8 |
|
Status Code |
|
・E90010001
・E92000001
・E92000002
・E91099996
・E91099997
EntryTranDocomoAccept 取引登録
これ以降の利用承諾で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID |
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード |
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID |
/payment/EntryTranDocomoAccept.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"orderID": "ORDER0000001"
}
/payment/EntryTranDocomoAccept.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001
レスポンス
{
"accessID": "a6a6b0061347e90cdef806b39bd28705",
"accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
[
{
"errCode":"E01",
"errInfo":"E01040001"
}
]
ErrCode=E01&ErrInfo=E01040001
ExecTranDocomoAccept 決済実行
これ以降の処理で必要となるトークンを返却します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID |
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード |
||
AccessID | accessID | 必須 半角英数32桁 固定
取引ID |
||
AccessPass | accessPass | 必須 半角英数32桁 固定
取引パスワード |
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID |
||
ClientField1 | clientField1 | 全半角100バイト
加盟店自由項目1 |
||
ClientField2 | clientField2 | 全半角100バイト
加盟店自由項目2 |
||
ClientField3 | clientField3 | 全半角100バイト
加盟店自由項目3 |
||
DocomoDisp1 | docomoDisp1 | 全半角40バイト
ドコモ表示項目1 |
||
DocomoDisp2 | docomoDisp2 | 全半角40バイト
ドコモ表示項目2 |
||
RetURL | retURL | 必須 半角英数記号256桁
決済結果戻しURL 加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。 |
||
PaymentTermSec | paymentTermSec | 半角数字5桁
支払開始期限秒 お客様が【決済実行】から【支払手続き開始IF】を呼び出すまでの期限です。 |
||
DispCompanyName | dispCompanyName | 全半角32バイト
会社名 |
||
DispShopName | dispShopName | 全半角32バイト
利用店舗名 |
||
DispPhoneNumber | dispPhoneNumber | 半角数字記号13桁
連絡先電話番号 |
||
DispMailAddress | dispMailAddress | 半角英数記号96桁
メールアドレス |
||
DispShopUrl | dispShopUrl | 半角英数記号96桁
問い合わせURL |
※ 直接契約加盟店様は、DispCompanyName~DispShopUrlの指定は不要です。
※ DispPhoneNumber~DispShopUrlの設定値の合計バイト数を96バイト以内にしてください。
/payment/ExecTranDocomoAccept.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"accessID": "a6a6b0061347e90cdef806b39bd28705",
"accessPass": "5e0e54b892e14ed03e8cf807a6053813",
"orderID": "ORDER0000001",
"retURL": "https://example.com/receive"
}
/payment/ExecTranDocomoAccept.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive
レスポンス
{
"accessID": "a6a6b0061347e90cdef806b39bd28705",
"token": "qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL",
"startURL": "https://x01.mul-pay.jp/payment/DocomoAcceptStart.idPass",
"startLimitDate": "20190225162711"
}
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL&StartURL=https://x01.mul-pay.jp/payment/DocomoAcceptStart.idPass&StartLimitDate=20190225162711
[
{
"errCode":"E01",
"errInfo":"E01040001"
}
]
ErrCode=E01&ErrInfo=E01040001
DocomoAcceptStart 支払手続き開始IF呼び出し
お客様をd払い画面へ誘導します。
※取引が特定できない場合、すでに利用承諾を済ませている場合、期限切れの場合等はエラー画面を表示します。
リクエスト
AccessID | 必須 半角英数32桁 固定
取引ID |
|
---|---|---|
Token | 必須 半角英数記号256桁 固定
トークン |
/payment/DocomoAcceptStart.idPass
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
</head>
<body OnLoad='OnLoadEvent();'>
<form name="DocomoAcceptStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
<noscript>
<br>
<br>
<center>
<h2>
d払いの利用承諾画面へ遷移します。
</h2>
<input type="submit" value="続行">
</center>
</noscript>
<input type="hidden" name="AccessID" value="{AccessID}">
<input type="hidden" name="Token" value="{Token}">
</form>
<script>
<!--
function OnLoadEvent() {
document.DocomoAcceptStartCall.submit();
}
//-->
</script>
</body>
</html>
決済結果受信
NTTドコモ社から、当サービスに認証・利用承諾結果が通知されます。
認証・利用承諾結果は、お客様が操作を完了した場合と認証・操作をキャンセルした場合に通知されます。
当サービスは、【決済実行】時に指定されたリダイレクトURLに利用承諾結果を通知します。
この利用承諾結果は、d払いの利用承諾完了画面からブラウザ経由で連携されるため、ユーザの操作方法によっては操作が完了したにもかかわらず、加盟店様に通知されないことがあります。その際はショップ管理画面または結果通知にて確認ください。
また、同様の理由でこの利用承諾結果が複数回加盟店様に通知されることがあります。
レスポンス
正常
ShopID | 必須
半角英数13桁
ショップID |
|
---|---|---|
OrderID | 必須
半角英数記号27桁
オーダーID |
|
Status | 必須
現状態該当取引の取引状態を返却します。 |
|
TranDate | 必須
半角数字14桁 固定
処理日時当サービスで処理を実施した日時を返却します。 |
|
DocomoAcceptCode | 必須
半角数字12桁
ドコモ承諾番号 |
|
CheckString | 必須
半角英数32桁
改ざんチェック文字列OrderID,AccessID,ShopID,ShopPassを連結しMD5ハッシュした値を返却します。 |
DocomoAcceptUserEnd 利用承諾終了
利用承諾の終了を行います。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID |
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード |
||
AccessID | accessID | 必須 半角英数32桁 固定
取引ID |
||
AccessPass | accessPass | 必須 半角英数32桁 固定
取引パスワード |
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID |
||
DocomoAcceptCode | docomoAcceptCode | 必須 半角英数12桁
ドコモ承諾番号
|
/payment/DocomoAcceptUserEnd.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"accessID": "a6a6b0061347e90cdef806b39bd28705",
"accessPass": "5e0e54b892e14ed03e8cf807a6053813",
"orderID": "ORDER0000001",
"docomoAcceptCode": "123456789012"
}
/payment/DocomoAcceptUserEnd.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&DocomoAcceptCode=123456789012
レスポンス
正常
OrderID | orderID | 半角英数記号27桁
オーダーID |
||
---|---|---|---|---|
Status | status |
現状態 処理成功時は以下のステータスが返却されます。 |
{
"orderID": "ORDER0000001",
"status": "END"
}
OrderID=ORDER0000001&Status=END
[
{
"errCode":"E01",
"errInfo":"E01040001"
}
]
ErrCode=E01&ErrInfo=E01040001
SearchTradeDocomoAccept/SearchTradeMulti 取引状態参照
対象取引の取引状態を取得します。
※SearchTradeMultiはidPass版にのみ対応しています。json版には対応しておりません。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID |
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード |
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID |
||
PayType | payType | 半角数字2桁
決済方法SearchTradeMultiをご利用の際は「31」を指定してください。 |
/payment/SearchTradeDocomoAccept.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"orderID": "ORDER0000001"
}
/payment/SearchTradeDocomoAccept.idPass
/payment/SearchTradeMulti.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001
レスポンス
正常
Status | status |
現状態UNPROCESSED:未決済 |
||
---|---|---|---|---|
ProcessDate | processDate | 半角数字14桁 固定
処理日時 処理を実施した日時を返却します。 |
||
JobCd | jobCd |
処理区分REGISTER:利用承諾 |
||
AccessID | accessID | 半角英数32桁 固定
取引ID |
||
AccessPass | accessPass | 半角英数32桁 固定
取引パスワード |
||
ClientField1 | clientField1 | 全半角100バイト
加盟店自由項目1 |
||
ClientField2 | clientField2 | 全半角100バイト
加盟店自由項目2 |
||
ClientField3 | clientField3 | 全半角100バイト
加盟店自由項目3 |
||
PayType | payType | 半角数字2桁
決済方法31:d払い(利用承諾) |
||
DocomoAcceptCode | docomoAcceptCode | 半角英数12桁
ドコモ承諾番号 |
||
ProcessLastDate | processLastDate | 半角数字14桁 固定
最終処理日時 利用承諾を行った日時、またはドコモ承諾番号を使用して随時決済を行った日時を返却します。 |
{
"status": "REGISTER",
"processDate": "20190213200436",
"jobCd": "REGISTER",
"accessID": "a6a6b0061347e90cdef806b39bd28705",
"accessPass": "5e0e54b892e14ed03e8cf807a6053813",
"clientField1": "",
"clientField2": "",
"clientField3": "",
"payType": "31",
"docomoAcceptCode": "123456789012",
"processLastDate": "20221018115555"
}
Status=REGISTER&ProcessDate=20190213200436&JobCd=REGISTER&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&ClientField1=&ClientField2=&ClientField3=&PayType=31&DocomoAcceptCode=123456789012&ProcessLastDate=20221018115555
[
{
"errCode":"E01",
"errInfo":"E01040001"
}
]
ErrCode=E01&ErrInfo=E01040001